Enhanced product custom attribute management through GraphQL API and Webhook updates

^{Major Upgrade}

This release introduces GraphQL API support for comprehensive management of custom attribute values on products, product editions, and product edition files, alongside an update to the StagingProductChanged webhook to include custom attributes.

These enhancements enable headless commerce platforms and API-first integrations to programmatically configure and retrieve custom product data, achieving full API parity with existing Product Editor UI functionality.

Features and enhancements

• GraphQL API for custom attributes: Developers and channel administrators can now create, update, and query custom attribute values directly through the GraphQL API, eliminating the need for UI access for product metadata management.
• Webhook integration: The StagingProductChanged webhook payload now includes custom attributes, ensuring backend systems receive complete and up-to-date product information upon UI-based updates without requiring additional API polling.

Customer impact

• API capabilities: Programmatically create, update, and query custom attribute values through GraphQL, enabling seamless integration with external systems.
• Developer experience: Streamlines workflows by allowing custom attribute management in single API calls. Query custom attributes alongside core product fields for complete product visibility.
• Webhook integration support: The StagingProductChanged webhook now includes custom attributes in its payload, eliminating the need for separate API calls or polling.
• Security and consistency: Maintains the same security model, validation rules, and permission checks as the existing Product Editor UI.
• API-first workflows: Fully supports DevOps and automation workflows that require programmatic product configuration.

GraphQL API changes

This update introduces new mutations for creating and updating custom attributes, and a new query for retrieving them:

New mutations

• createProductCustomAttributeValue
• updateProductCustomAttributeValue
• createProductEditionCustomAttributeValue
• updateProductEditionCustomAttributeValue
• createProductEditionFilesCustomAttributeValue
• updateProductEditionFilesCustomAttributeValue

New queries

• productCustomAttributes
• productEditionCustomAttributeValues
• productEditionFileCustomAttributeValues

Webhook changes

StagingProductChanged webhook

• Payload update: The webhook payload now includes a new customAttributes field containing all custom attribute values for the updated product.
• Trigger: Continues to be triggered when products are updated through the Product Editor UI (Manage Profile page).

Feature enablement

No feature enablement is required.

Setting enablement

No setting enablement is required.

Documentation

Documentation will be updated with the release.